/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_drv_client.h
 *
 * @brief 声明TEE驱动客户端API。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_drv_client.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef TEE_DRV_CLIENT_H
#define TEE_DRV_CLIENT_H

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 在TEE中打开指定的驱动程序。
 *
 * @param drv_name [IN]驱动程序名称。
 * @param param [IN]参数信息。
 * @param param_len [IN]参数的长度。
 *
 * @return 返回大于0的值，表示对应驱动的文件描述符。\n
 *         返回小于或等于0的值，表示打开驱动失败。
 *
 * @since 20
 */
int64_t tee_drv_open(const char *drv_name, const void *param, uint32_t param_len);

/**
 * @brief 取消操作。
 *
 * @param fd [IN]驱动的文件描述符。
 * @param cmd_id [IN]命令ID。
 * @param param [IN]参数信息。
 * @param param_len [IN]参数的长度。
 *
 * @return 返回0，表示操作成功。\n
 *         返回-1，表示操作失败。
 *
 * @since 20
 */
int64_t tee_drv_ioctl(int64_t fd, uint32_t cmd_id, const void *param, uint32_t param_len);

/**
 * @brief 关闭在TEE中打开的驱动程序。
 *
 * @param fd [IN]驱动的文件描述符。
 *
 * @return 返回0，表示操作成功。\n
 *         返回-1，表示操作失败。
 *
 * @since 20
 */
int64_t tee_drv_close(int64_t fd);

#ifdef __cplusplus
}
#endif

#endif
/** @} */